Boleto Bancário baixado Webhook

info

📘 Para saber mais sobre webhooks em nossa API, siga o link abaixo:

Sobre Webhooks

Quando uma cobrança de boleto bancário é baixada, a melhor maneira de receber essa informação é usando o webhook CHARGE_VOIDED. Assim que uma cobrança de boleto bancário é baixada, um webhook CHARGE_VOIDED é enviado para a URL cadastrada.

Esta é a maneira mais simples de configurar um webhook CHARGE_VOIDED:

Headers

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave de API
x-delfinance-account-id	Obrigatório. O número da conta Delfinance.

Corpo da requisição

{
  "eventType": "CHARGE_VOIDED",
  "url": "https://example.com.br/webhooks/v1/chargevoided",
  "authorization": "NONE",
  "authorizationScheme": "NONE"
}

Assim que o boleto bancário é baixado, aqui está o que você receberá na URL cadastrada:

CHARGE_VOIDED

{
  "dynamicQrCodeExpiresInDefault": 86400,
  "id": 326344,
  "bankAccount": "10073",
  "correlationId": "992b1814-37c2-487b-b0e0-acdfeaff643a",
  "type": "BANKSLIP_PIX",
  "amount": 1.11,
  "dueDate": "2026-03-18T02:59:59",
  "dueDateBrazil": "2026-03-18T02:59:59",
  "status": "Voided",
  "payers": [
    {
      "id": 290387,
      "chargeId": 326344,
      "type": "Payer",
      "name": "JOSEPHTESTERSONPOGGERSON",
      "document": "30030030030",
      "email": "[email protected]",
      "dialCode": "79",
      "phoneNumber": "999999999",
      "address": {
        "payerId": 290387,
        "zipCode": "01030000",
        "publicPlace": "Rua Florencio de Abreu",
        "number": "S/N",
        "neighborhood": "Centro",
        "complement": "",
        "city": "SÃO PAULO",
        "state": "SP"
      }
    }
  ],
  "pix": {
    "chargeId": 326344,
    "identifier": "vcharge0000000000000326344",
    "qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003263445204000053039865802BR5907DELBANK6009SAO PAULO62070503***63043894",
    "additionalInfo": [
      {
        "key": "YourNumber",
        "value": "10"
      },
      {
        "key": "OurNumber",
        "value": "00000546293"
      },
      {
        "key": "DigitableLine",
        "value": "43590001161200000160700005462932313880000000111"
      }
    ]
  },
  "bankslip": {
    "chargeId": 326344,
    "walletNumber": "112",
    "yourNumber": "10",
    "ourNumber": "00000546293",
    "barCode": "43593138800000001110001112000001600000546293",
    "digitableLine": "43590001161200000160700005462932313880000000111"
  },
  "beneficiary": {
    "bankAccount": "10073",
    "customerName": "AlterandoNome",
    "customerDocument": "10613462939",
    "customerEmail": "[email protected]",
    "accountHeader": "43500000160000010073",
    "publicPlace": "Comendador Norberto Marcondes",
    "number": "2533",
    "zipCode": "87303100",
    "neighborhood": "Centro",
    "complement": "bloco 6 ap 01",
    "cityName": "CAMPO MOURÃO",
    "cityState": "PR",
    "cnabDirectorySource": "C:\\Autbank\\COBRANCA\\10073\\ORIGEM",
    "cnabDirectoryDestination": "C:\\Autbank\\COBRANCA\\10073\\DESTINO",
    "cnabNameFileDefault": "CB10073.REM",
    "charges": [],
    "remittances": []
  },
  "fees": [],
  "payments": [],
  "formatResponse": "PAYLOAD_AND_IMAGEBASE64",
  "isBankslipType": true,
  "hasPaymentSourceSiloc": false,
  "events": [
    {
      "id": 3085,
      "chargeId": 326344,
      "eventType": "VOIDED",
      "sourceType": "CEDENT",
      "createdAt": "2025-07-10T19:29:57.007"
    }
  ],
  "providerStatus": "Voided",
  "writtenOffAt": "2026-06-01T20:09:54.1188588Z",
  "updatedAt": "2026-06-01T20:09:54.1187818Z",
  "createdAt": "2025-06-16T19:27:21.573"
}

Aqui estão os principais atributos que são passados pelo webhook CHARGE_VOIDED:

Nome	Descrição
dynamicQrCodeExpiresInDefault	O tempo padrão de expiração, em segundos, do QR Code dinâmico.
id	O identificador único da cobrança.
bankAccount	O número da conta Delfinance associada à cobrança.
correlationId	Um identificador único usado para rastrear a cobrança.
type	O tipo da cobrança, como BANKSLIP_PIX.
amount	O valor da cobrança.
dueDate	A data de vencimento da cobrança.
dueDateBrazil	A data de vencimento da cobrança no horário brasileiro.
status	O status atual da cobrança, como Voided.
payers	Uma lista contendo as informações dos pagadores.
payers.id	O identificador do pagador.
payers.chargeId	O identificador da cobrança associada ao pagador.
payers.type	O tipo do pagador.
payers.name	O nome do pagador.
payers.document	O número do documento do pagador.
payers.email	O e-mail do pagador.
payers.dialCode	O DDD/código de discagem do telefone do pagador.
payers.phoneNumber	O número de telefone do pagador.
payers.address	Um objeto contendo as informações de endereço do pagador.
pix	Um objeto contendo informações de Pix da cobrança.
pix.identifier	O identificador da cobrança Pix.
pix.qrCode	O payload do QR Code Pix.
pix.additionalInfo	Informações adicionais relacionadas à cobrança Pix.
bankslip	Um objeto contendo informações de boleto bancário da cobrança.
bankslip.walletNumber	O número da carteira.
bankslip.yourNumber	O identificador interno do cliente para o boleto.
bankslip.ourNumber	O identificador bancário do boleto.
bankslip.barCode	O código de barras do boleto.
bankslip.digitableLine	A linha digitável do boleto.
beneficiary	Um objeto contendo informações do beneficiário.
fees	Uma lista contendo informações de tarifas, quando houver.
payments	Uma lista contendo informações de pagamentos, quando houver.
formatResponse	O formato de resposta configurado para a cobrança.
isBankslipType	Indica se a cobrança é do tipo boleto.
hasPaymentSourceSiloc	Indica se a cobrança possui origem de pagamento Siloc.
events	Uma lista contendo eventos relacionados à cobrança.
events.eventType	O evento registrado para a cobrança, como VOIDED.
events.sourceType	A origem que gerou o evento.
providerStatus	O status retornado pelo provedor.
writtenOffAt	O timestamp que indica quando a cobrança foi baixada.
updatedAt	O timestamp que indica quando a cobrança foi atualizada pela última vez.
createdAt	O timestamp que indica quando a cobrança foi criada.